Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(python): Add make docs command, DataType docs/layout tweak, minor README updates #15386

Merged
merged 6 commits into from
Apr 3, 2024

Conversation

alexander-beedie
Copy link
Collaborator

@alexander-beedie alexander-beedie commented Mar 29, 2024

A handful of minor docs-related updates:

  • Added make docs (incremental) and make docs-clean (full rebuild) commands to the regular py-polars Makefile; has always been something of a minor irritation having to remember to cd into a different directory to do this, issue the relevant make command, and then have to cd back.
  • Some minor improvements to datatypes/rst docs; the various String-related types (eg: inc. Enum and Categorical) are now bundled together under "String" instead of ending up in the miscellaneous grab-bag of "Other" (string types are important).
  • Changed the "Use custom Rust function in Python?" header in the README to "Using custom Rust functions in Python" as it shouldn't really come across as a question (or a singular "function").
  • Sorted the list of optional dependencies in the README and added a couple of the more important missing ones.

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars labels Mar 29, 2024
@alexander-beedie alexander-beedie changed the title docs: Add make docs command, minor page/datatype layout tweak docs: Add make docs command, datatype docs/layout tweak, minor README updates Mar 29, 2024
@alexander-beedie alexander-beedie changed the title docs: Add make docs command, datatype docs/layout tweak, minor README updates docs: Add make docs command, DataType docs/layout tweak, minor README updates Mar 29, 2024
Copy link
Member

@stinodego stinodego left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely happy with the new make commands 👍 . Not so sure about a lot of the other changes.

py-polars/docs/source/reference/datatypes.rst Show resolved Hide resolved
py-polars/Makefile Outdated Show resolved Hide resolved
py-polars/Makefile Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@ritchie46
Copy link
Member

@stinodego can this go in now?

@stinodego stinodego merged commit 273adf5 into pola-rs:main Apr 3, 2024
11 checks passed
@stinodego stinodego changed the title docs: Add make docs command, DataType docs/layout tweak, minor README updates docs(python): Add make docs command, DataType docs/layout tweak, minor README updates Apr 3, 2024
@stinodego stinodego removed the rust Related to Rust Polars label Apr 3, 2024
@alexander-beedie alexander-beedie deleted the misc-docs branch April 3, 2024 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation python Related to Python Polars
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants